Frameworks/Adium Framework/IntegerMath.h

   1 /*!
   2         @header IntegerMath.h
   3         @abstract Function to perform integer maths.
   4         @discussion Contains function that are integer version of float math opperations, e.g. <tt>log10I</tt> or function that are really only applicaple as integer opperations, e.g. <tt>greatestCommonDivisor</tt>
   5
   6         Created by Nathan Day on Sun Jun 29 2003.
   7         Copyright &#169; 2003 Nathan Day. All rights reserved.
   8  */
   9
  10 /*!
  11         @function log10I
  12         @abstract Returns the base 10 logarithm for <tt><i>num</i></tt>.
  13         @discussion <tt>log10I</tt> returns the largest integer less than 10 base logarithm of the unsigned long int <tt><i>num</i></tt>. It is equivelent to <code>(int)logf( num )</code>
  14         @param num The integer for which the logarithm is desired.
  15         @result largest integer less than 10 base logarithm.
  16  */
  17 unsigned short log10I( const unsigned long num );
  18
  19 /*!
  20         @function greatestCommonDivisor
  21         @abstract Return the greatest common divisor
  22         @discussion The function <tt>greatestCommonDivisor</tt> returns the greatest common divisor of the two integers <tt><i>a</i></tt> and <tt><i>b</i></tt>.
  23         @param a A <tt>unsigned long int</tt>
  24         @param b A <tt>unsigned long int</tt>
  25         @result The greatest common divisor.
  26  */
  27 unsigned long greatestCommonDivisor( unsigned long a, unsigned long b );